# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Shared protobuf message mocking utilities."""

from __future__ import annotations

from typing import TYPE_CHECKING

from streamlit.cursor import make_delta_path
from streamlit.elements import arrow
from streamlit.proto.Block_pb2 import Block as BlockProto
from streamlit.proto.ForwardMsg_pb2 import ForwardMsg
from streamlit.proto.RootContainer_pb2 import RootContainer

if TYPE_CHECKING:
    from streamlit.elements.arrow import Data


def create_dataframe_msg(df: Data, id: int = 1) -> ForwardMsg:
    """Create a mock legacy_data_frame ForwardMsg."""
    msg = ForwardMsg()
    msg.metadata.delta_path[:] = make_delta_path(RootContainer.SIDEBAR, (), id)
    arrow.marshall(msg.delta.new_element.arrow_data_frame, df)
    return msg


def create_container_msg(id: int = 1) -> ForwardMsg:
    """Create a mock container ForwardMsg."""
    msg = ForwardMsg()
    msg.metadata.delta_path[:] = make_delta_path(RootContainer.SIDEBAR, (), id)

    new_block = BlockProto()
    new_block.allow_empty = False
    new_block.vertical.border = False

    msg.delta.add_block.CopyFrom(new_block)
    return msg


def create_script_finished_message(
    status: ForwardMsg.ScriptFinishedStatus.ValueType,
) -> ForwardMsg:
    """Create a script_finished ForwardMsg."""
    msg = ForwardMsg()
    msg.script_finished = status
    return msg
